

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Planner &mdash; O365  documentation</title>
      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />

  
      <script src="../_static/jquery.js?v=5d32c60e"></script>
      <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
      <script src="../_static/documentation_options.js?v=5929fcd5"></script>
      <script src="../_static/doctools.js?v=9bcbadda"></script>
      <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Sharepoint" href="sharepoint.html" />
    <link rel="prev" title="One Drive" href="onedrive.html" />
    <link href="../_static/css/style.css" rel="stylesheet" type="text/css">

</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="../index.html">
            
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage.html">Detailed Usage</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">O365 API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="account.html">Account</a></li>
<li class="toctree-l2"><a class="reference internal" href="address_book.html">Address Book</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendar</a></li>
<li class="toctree-l2"><a class="reference internal" href="category.html">Category</a></li>
<li class="toctree-l2"><a class="reference internal" href="connection.html">Connection</a></li>
<li class="toctree-l2"><a class="reference internal" href="directory.html">Directory</a></li>
<li class="toctree-l2"><a class="reference internal" href="excel.html">Excel</a></li>
<li class="toctree-l2"><a class="reference internal" href="group.html">Group</a></li>
<li class="toctree-l2"><a class="reference internal" href="mailbox.html">Mailbox</a></li>
<li class="toctree-l2"><a class="reference internal" href="message.html">Message</a></li>
<li class="toctree-l2"><a class="reference internal" href="onedrive.html">One Drive</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Planner</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#O365.planner.Bucket"><code class="docutils literal notranslate"><span class="pre">Bucket</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Bucket.__init__"><code class="docutils literal notranslate"><span class="pre">Bucket.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Bucket.create_task"><code class="docutils literal notranslate"><span class="pre">Bucket.create_task()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Bucket.delete"><code class="docutils literal notranslate"><span class="pre">Bucket.delete()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Bucket.list_tasks"><code class="docutils literal notranslate"><span class="pre">Bucket.list_tasks()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Bucket.update"><code class="docutils literal notranslate"><span class="pre">Bucket.update()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Bucket.name"><code class="docutils literal notranslate"><span class="pre">Bucket.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Bucket.object_id"><code class="docutils literal notranslate"><span class="pre">Bucket.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Bucket.order_hint"><code class="docutils literal notranslate"><span class="pre">Bucket.order_hint</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Bucket.plan_id"><code class="docutils literal notranslate"><span class="pre">Bucket.plan_id</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.planner.Plan"><code class="docutils literal notranslate"><span class="pre">Plan</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Plan.__init__"><code class="docutils literal notranslate"><span class="pre">Plan.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Plan.create_bucket"><code class="docutils literal notranslate"><span class="pre">Plan.create_bucket()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Plan.delete"><code class="docutils literal notranslate"><span class="pre">Plan.delete()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Plan.get_details"><code class="docutils literal notranslate"><span class="pre">Plan.get_details()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Plan.list_buckets"><code class="docutils literal notranslate"><span class="pre">Plan.list_buckets()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Plan.list_tasks"><code class="docutils literal notranslate"><span class="pre">Plan.list_tasks()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Plan.update"><code class="docutils literal notranslate"><span class="pre">Plan.update()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Plan.created_date_time"><code class="docutils literal notranslate"><span class="pre">Plan.created_date_time</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Plan.group_id"><code class="docutils literal notranslate"><span class="pre">Plan.group_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Plan.object_id"><code class="docutils literal notranslate"><span class="pre">Plan.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Plan.title"><code class="docutils literal notranslate"><span class="pre">Plan.title</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.planner.PlanDetails"><code class="docutils literal notranslate"><span class="pre">PlanDetails</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.PlanDetails.__init__"><code class="docutils literal notranslate"><span class="pre">PlanDetails.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.PlanDetails.update"><code class="docutils literal notranslate"><span class="pre">PlanDetails.update()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.PlanDetails.category_descriptions"><code class="docutils literal notranslate"><span class="pre">PlanDetails.category_descriptions</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.PlanDetails.object_id"><code class="docutils literal notranslate"><span class="pre">PlanDetails.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.PlanDetails.shared_with"><code class="docutils literal notranslate"><span class="pre">PlanDetails.shared_with</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.planner.Planner"><code class="docutils literal notranslate"><span class="pre">Planner</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Planner.__init__"><code class="docutils literal notranslate"><span class="pre">Planner.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Planner.create_plan"><code class="docutils literal notranslate"><span class="pre">Planner.create_plan()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Planner.get_bucket_by_id"><code class="docutils literal notranslate"><span class="pre">Planner.get_bucket_by_id()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Planner.get_my_tasks"><code class="docutils literal notranslate"><span class="pre">Planner.get_my_tasks()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Planner.get_plan_by_id"><code class="docutils literal notranslate"><span class="pre">Planner.get_plan_by_id()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Planner.get_task_by_id"><code class="docutils literal notranslate"><span class="pre">Planner.get_task_by_id()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Planner.list_group_plans"><code class="docutils literal notranslate"><span class="pre">Planner.list_group_plans()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Planner.list_user_tasks"><code class="docutils literal notranslate"><span class="pre">Planner.list_user_tasks()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.planner.Task"><code class="docutils literal notranslate"><span class="pre">Task</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.__init__"><code class="docutils literal notranslate"><span class="pre">Task.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.delete"><code class="docutils literal notranslate"><span class="pre">Task.delete()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.get_details"><code class="docutils literal notranslate"><span class="pre">Task.get_details()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.update"><code class="docutils literal notranslate"><span class="pre">Task.update()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.active_checklist_item_count"><code class="docutils literal notranslate"><span class="pre">Task.active_checklist_item_count</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.applied_categories"><code class="docutils literal notranslate"><span class="pre">Task.applied_categories</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.assignee_priority"><code class="docutils literal notranslate"><span class="pre">Task.assignee_priority</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.assignments"><code class="docutils literal notranslate"><span class="pre">Task.assignments</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.bucket_id"><code class="docutils literal notranslate"><span class="pre">Task.bucket_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.checklist_item_count"><code class="docutils literal notranslate"><span class="pre">Task.checklist_item_count</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.completed_date"><code class="docutils literal notranslate"><span class="pre">Task.completed_date</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.conversation_thread_id"><code class="docutils literal notranslate"><span class="pre">Task.conversation_thread_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.created_date"><code class="docutils literal notranslate"><span class="pre">Task.created_date</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.due_date_time"><code class="docutils literal notranslate"><span class="pre">Task.due_date_time</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.has_description"><code class="docutils literal notranslate"><span class="pre">Task.has_description</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.object_id"><code class="docutils literal notranslate"><span class="pre">Task.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.order_hint"><code class="docutils literal notranslate"><span class="pre">Task.order_hint</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.percent_complete"><code class="docutils literal notranslate"><span class="pre">Task.percent_complete</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.plan_id"><code class="docutils literal notranslate"><span class="pre">Task.plan_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.preview_type"><code class="docutils literal notranslate"><span class="pre">Task.preview_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.priority"><code class="docutils literal notranslate"><span class="pre">Task.priority</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.reference_count"><code class="docutils literal notranslate"><span class="pre">Task.reference_count</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.start_date_time"><code class="docutils literal notranslate"><span class="pre">Task.start_date_time</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.Task.title"><code class="docutils literal notranslate"><span class="pre">Task.title</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.planner.TaskDetails"><code class="docutils literal notranslate"><span class="pre">TaskDetails</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.TaskDetails.__init__"><code class="docutils literal notranslate"><span class="pre">TaskDetails.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.TaskDetails.update"><code class="docutils literal notranslate"><span class="pre">TaskDetails.update()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.TaskDetails.checklist"><code class="docutils literal notranslate"><span class="pre">TaskDetails.checklist</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.TaskDetails.description"><code class="docutils literal notranslate"><span class="pre">TaskDetails.description</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.TaskDetails.object_id"><code class="docutils literal notranslate"><span class="pre">TaskDetails.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.TaskDetails.preview_type"><code class="docutils literal notranslate"><span class="pre">TaskDetails.preview_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.planner.TaskDetails.references"><code class="docutils literal notranslate"><span class="pre">TaskDetails.references</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="sharepoint.html">Sharepoint</a></li>
<li class="toctree-l2"><a class="reference internal" href="tasks.html">Tasks</a></li>
<li class="toctree-l2"><a class="reference internal" href="teams.html">Teams</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
</ul>
</li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">O365</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="../api.html">O365 API</a></li>
      <li class="breadcrumb-item active">Planner</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../_sources/api/planner.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation">
        <a href="onedrive.html" class="btn btn-neutral float-left" title="One Drive" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="sharepoint.html" class="btn btn-neutral float-right" title="Sharepoint" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  </div>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="planner">
<h1>Planner<a class="headerlink" href="#planner" title="Link to this heading"></a></h1>
<dl class="py class" id="module-O365.planner">
<dt class="sig sig-object py" id="O365.planner.Bucket">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.planner.</span></span><span class="sig-name descname"><span class="pre">Bucket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Bucket"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Bucket" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils/utils.html#O365.utils.utils.ApiComponent" title="O365.utils.utils.ApiComponent"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApiComponent</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Bucket.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Bucket.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Bucket.__init__" title="Link to this definition"></a></dt>
<dd><p>A Microsoft 365 bucket</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> (<a class="reference internal" href="#O365.planner.Planner" title="O365.planner.Planner"><em>Planner</em></a><em> or </em><a class="reference internal" href="#O365.planner.Plan" title="O365.planner.Plan"><em>Plan</em></a>) – parent object</p></li>
<li><p><strong>con</strong> (<a class="reference internal" href="connection.html#O365.connection.Connection" title="O365.connection.Connection"><em>Connection</em></a>) – connection to use if no parent specified</p></li>
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – protocol to use if no parent specified
(kwargs)</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – use this resource instead of parent resource
(kwargs)</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Bucket.create_task">
<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">assignments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Bucket.create_task"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Bucket.create_task" title="Link to this definition"></a></dt>
<dd><p>Creates a Task</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>title</strong> (<em>str</em>) – the title of the task</p></li>
<li><p><strong>assignments</strong> (<em>dict</em>) – the dict of users to which tasks are to be assigned.</p></li>
</ul>
</dd>
</dl>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="n">assignments</span> <span class="o">=</span> <span class="p">{</span>
      <span class="s2">&quot;ca2a1df2-e36b-4987-9f6b-0ea462f4eb47&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
      <span class="s2">&quot;4e98f8f1-bb03-4015-b8e0-19bb370949d8&quot;</span><span class="p">:</span> <span class="p">{</span>
          <span class="s2">&quot;@odata.type&quot;</span><span class="p">:</span> <span class="s2">&quot;microsoft.graph.plannerAssignment&quot;</span><span class="p">,</span>
          <span class="s2">&quot;orderHint&quot;</span><span class="p">:</span> <span class="s2">&quot;String&quot;</span>
        <span class="p">}</span>
    <span class="p">}</span>
<span class="k">if</span> <span class="s2">&quot;user_id&quot;</span><span class="p">:</span> <span class="n">null</span> <span class="o">-&gt;</span> <span class="n">task</span> <span class="ow">is</span> <span class="n">unassigned</span> <span class="n">to</span> <span class="n">user</span><span class="o">.</span>
<span class="k">if</span> <span class="s2">&quot;user_id&quot;</span><span class="p">:</span> <span class="nb">dict</span> <span class="o">-&gt;</span> <span class="n">task</span> <span class="ow">is</span> <span class="n">assigned</span> <span class="n">to</span> <span class="n">user</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>kwargs</strong> (<em>dict</em>) – optional extra parameters to include in the task</p></li>
<li><p><strong>priority</strong> (<em>int</em>) – <p>priority of the task. The valid range of values is between 0 and 10.</p>
<p>1 -&gt; “urgent”, 3 -&gt; “important”, 5 -&gt; “medium”, 9 -&gt; “low” (kwargs)</p>
</p></li>
<li><p><strong>order_hint</strong> (<em>str</em>) – the order of the bucket. Default is on top (kwargs)</p></li>
<li><p><strong>start_date_time</strong> (<em>datetime</em><em> or </em><em>str</em>) – the starting date of the task. If str format should be: “%Y-%m-%dT%H:%M:%SZ” (kwargs)</p></li>
<li><p><strong>due_date_time</strong> (<em>datetime</em><em> or </em><em>str</em>) – the due date of the task. If str format should be: “%Y-%m-%dT%H:%M:%SZ” (kwargs)</p></li>
<li><p><strong>conversation_thread_id</strong> (<em>str</em>) – <p>thread ID of the conversation on the task.</p>
<p>This is the ID of the conversation thread object created in the group (kwargs)</p>
</p></li>
<li><p><strong>assignee_priority</strong> (<em>str</em>) – hint used to order items of this type in a list view (kwargs)</p></li>
<li><p><strong>percent_complete</strong> (<em>int</em>) – percentage of task completion. When set to 100, the task is considered completed (kwargs)</p></li>
<li><p><strong>applied_categories</strong> (<em>dict</em>) – <p>The categories (labels) to which the task has been applied.</p>
<p>Format should be e.g. {“category1”: true, “category3”: true, “category5”: true } should (kwargs)</p>
</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>newly created task</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#O365.planner.Task" title="O365.planner.Task">Task</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Bucket.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Bucket.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Bucket.delete" title="Link to this definition"></a></dt>
<dd><p>Deletes this bucket</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Success / Failure</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Bucket.list_tasks">
<span class="sig-name descname"><span class="pre">list_tasks</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Bucket.list_tasks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Bucket.list_tasks" title="Link to this definition"></a></dt>
<dd><p>Returns list of tasks that given plan has
:rtype: list[Task]</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Bucket.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Bucket.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Bucket.update" title="Link to this definition"></a></dt>
<dd><p>Updates this bucket</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>kwargs</strong> – all the properties to be updated.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Success / Failure</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Bucket.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#O365.planner.Bucket.name" title="Link to this definition"></a></dt>
<dd><p>Name of the bucket. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Bucket.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.planner.Bucket.object_id" title="Link to this definition"></a></dt>
<dd><p>ID of the bucket. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Bucket.order_hint">
<span class="sig-name descname"><span class="pre">order_hint</span></span><a class="headerlink" href="#O365.planner.Bucket.order_hint" title="Link to this definition"></a></dt>
<dd><p>Hint used to order items of this type in a list view. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Bucket.plan_id">
<span class="sig-name descname"><span class="pre">plan_id</span></span><a class="headerlink" href="#O365.planner.Bucket.plan_id" title="Link to this definition"></a></dt>
<dd><p>Plan ID to which the bucket belongs. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.planner.Plan">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.planner.</span></span><span class="sig-name descname"><span class="pre">Plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Plan" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils/utils.html#O365.utils.utils.ApiComponent" title="O365.utils.utils.ApiComponent"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApiComponent</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Plan.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Plan.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Plan.__init__" title="Link to this definition"></a></dt>
<dd><p>A Microsoft 365 plan</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> (<a class="reference internal" href="#O365.planner.Planner" title="O365.planner.Planner"><em>Planner</em></a>) – parent object</p></li>
<li><p><strong>con</strong> (<a class="reference internal" href="connection.html#O365.connection.Connection" title="O365.connection.Connection"><em>Connection</em></a>) – connection to use if no parent specified</p></li>
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – protocol to use if no parent specified
(kwargs)</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – use this resource instead of parent resource
(kwargs)</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Plan.create_bucket">
<span class="sig-name descname"><span class="pre">create_bucket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order_hint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'</span> <span class="pre">!'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Plan.create_bucket"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Plan.create_bucket" title="Link to this definition"></a></dt>
<dd><p>Creates a Bucket</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em>) – the name of the bucket</p></li>
<li><p><strong>order_hint</strong> (<em>str</em>) – the order of the bucket. Default is on top.
How to use order hints here: <a class="reference external" href="https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0">https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0</a></p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>newly created bucket</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#O365.planner.Bucket" title="O365.planner.Bucket">Bucket</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Plan.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Plan.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Plan.delete" title="Link to this definition"></a></dt>
<dd><p>Deletes this plan</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Success / Failure</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Plan.get_details">
<span class="sig-name descname"><span class="pre">get_details</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Plan.get_details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Plan.get_details" title="Link to this definition"></a></dt>
<dd><p>Returns Microsoft 365/AD plan with given id</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#O365.planner.PlanDetails" title="O365.planner.PlanDetails">PlanDetails</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Plan.list_buckets">
<span class="sig-name descname"><span class="pre">list_buckets</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Plan.list_buckets"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Plan.list_buckets" title="Link to this definition"></a></dt>
<dd><p>Returns list of buckets that given plan has
:rtype: list[Bucket]</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Plan.list_tasks">
<span class="sig-name descname"><span class="pre">list_tasks</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Plan.list_tasks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Plan.list_tasks" title="Link to this definition"></a></dt>
<dd><p>Returns list of tasks that given plan has
:rtype: list[Task] or Pagination of Task</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Plan.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Plan.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Plan.update" title="Link to this definition"></a></dt>
<dd><p>Updates this plan</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>kwargs</strong> – all the properties to be updated.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Success / Failure</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Plan.created_date_time">
<span class="sig-name descname"><span class="pre">created_date_time</span></span><a class="headerlink" href="#O365.planner.Plan.created_date_time" title="Link to this definition"></a></dt>
<dd><p>Date and time at which the plan is created. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> datetime</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Plan.group_id">
<span class="sig-name descname"><span class="pre">group_id</span></span><a class="headerlink" href="#O365.planner.Plan.group_id" title="Link to this definition"></a></dt>
<dd><p>The identifier of the resource that contains the plan. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Plan.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.planner.Plan.object_id" title="Link to this definition"></a></dt>
<dd><p>ID of the plan. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Plan.title">
<span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#O365.planner.Plan.title" title="Link to this definition"></a></dt>
<dd><p>Title of the plan. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.planner.PlanDetails">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.planner.</span></span><span class="sig-name descname"><span class="pre">PlanDetails</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#PlanDetails"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.PlanDetails" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils/utils.html#O365.utils.utils.ApiComponent" title="O365.utils.utils.ApiComponent"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApiComponent</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.PlanDetails.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#PlanDetails.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.PlanDetails.__init__" title="Link to this definition"></a></dt>
<dd><p>A Microsoft 365 plan details</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> (<a class="reference internal" href="#O365.planner.Plan" title="O365.planner.Plan"><em>Plan</em></a>) – parent object</p></li>
<li><p><strong>con</strong> (<a class="reference internal" href="connection.html#O365.connection.Connection" title="O365.connection.Connection"><em>Connection</em></a>) – connection to use if no parent specified</p></li>
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – protocol to use if no parent specified
(kwargs)</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – use this resource instead of parent resource
(kwargs)</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.PlanDetails.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#PlanDetails.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.PlanDetails.update" title="Link to this definition"></a></dt>
<dd><p>Updates this plan detail</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>kwargs</strong> – all the properties to be updated.</p></li>
<li><p><strong>shared_with</strong> (<em>dict</em>) – dict where keys are user_ids and values are boolean (kwargs)</p></li>
<li><p><strong>category_descriptions</strong> (<em>dict</em>) – dict where keys are category1, category2, …, category25 and values are the label associated with (kwargs)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Success / Failure</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.PlanDetails.category_descriptions">
<span class="sig-name descname"><span class="pre">category_descriptions</span></span><a class="headerlink" href="#O365.planner.PlanDetails.category_descriptions" title="Link to this definition"></a></dt>
<dd><p>An object that specifies the descriptions of the 25 categories
that can be associated with tasks in the plan. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> any</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.PlanDetails.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.planner.PlanDetails.object_id" title="Link to this definition"></a></dt>
<dd><p>The unique identifier for the plan details. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.PlanDetails.shared_with">
<span class="sig-name descname"><span class="pre">shared_with</span></span><a class="headerlink" href="#O365.planner.PlanDetails.shared_with" title="Link to this definition"></a></dt>
<dd><p>Set of user IDs that this plan is shared with. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> any</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.planner.Planner">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.planner.</span></span><span class="sig-name descname"><span class="pre">Planner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Planner"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Planner" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils/utils.html#O365.utils.utils.ApiComponent" title="O365.utils.utils.ApiComponent"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApiComponent</span></code></a></p>
<p>A microsoft planner class</p>
<p>In order to use the API following permissions are required.
Delegated (work or school account) - Group.Read.All, Group.ReadWrite.All</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Planner.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Planner.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Planner.__init__" title="Link to this definition"></a></dt>
<dd><p>A Planner object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> (<a class="reference internal" href="account.html#O365.account.Account" title="O365.account.Account"><em>Account</em></a>) – parent object</p></li>
<li><p><strong>con</strong> (<a class="reference internal" href="connection.html#O365.connection.Connection" title="O365.connection.Connection"><em>Connection</em></a>) – connection to use if no parent specified</p></li>
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – protocol to use if no parent specified
(kwargs)</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – use this resource instead of parent resource
(kwargs)</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Planner.create_plan">
<span class="sig-name descname"><span class="pre">create_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">owner</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Tasks'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Planner.create_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Planner.create_plan" title="Link to this definition"></a></dt>
<dd><p>Creates a Plan</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>owner</strong> (<em>str</em>) – the id of the group that will own the plan</p></li>
<li><p><strong>title</strong> (<em>str</em>) – the title of the new plan. Default set to “Tasks”</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>newly created plan</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#O365.planner.Plan" title="O365.planner.Plan">Plan</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Planner.get_bucket_by_id">
<span class="sig-name descname"><span class="pre">get_bucket_by_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bucket_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Planner.get_bucket_by_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Planner.get_bucket_by_id" title="Link to this definition"></a></dt>
<dd><p>Returns Microsoft 365/AD plan with given id</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>bucket_id</strong> – bucket id of buckets</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#O365.planner.Bucket" title="O365.planner.Bucket">Bucket</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Planner.get_my_tasks">
<span class="sig-name descname"><span class="pre">get_my_tasks</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Planner.get_my_tasks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Planner.get_my_tasks" title="Link to this definition"></a></dt>
<dd><p>Returns a list of open planner tasks assigned to me</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tasks</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Planner.get_plan_by_id">
<span class="sig-name descname"><span class="pre">get_plan_by_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Planner.get_plan_by_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Planner.get_plan_by_id" title="Link to this definition"></a></dt>
<dd><p>Returns Microsoft 365/AD plan with given id</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>plan_id</strong> – plan id of plan</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#O365.planner.Plan" title="O365.planner.Plan">Plan</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Planner.get_task_by_id">
<span class="sig-name descname"><span class="pre">get_task_by_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Planner.get_task_by_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Planner.get_task_by_id" title="Link to this definition"></a></dt>
<dd><p>Returns Microsoft 365/AD plan with given id</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>task_id</strong> – task id of tasks</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#O365.planner.Task" title="O365.planner.Task">Task</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Planner.list_group_plans">
<span class="sig-name descname"><span class="pre">list_group_plans</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Planner.list_group_plans"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Planner.list_group_plans" title="Link to this definition"></a></dt>
<dd><p>Returns list of plans that given group has
:param group_id: group id
:rtype: list[Plan]</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Planner.list_user_tasks">
<span class="sig-name descname"><span class="pre">list_user_tasks</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Planner.list_user_tasks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Planner.list_user_tasks" title="Link to this definition"></a></dt>
<dd><p>Returns Microsoft 365/AD plan with given id</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>user_id</strong> – user id</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list[<a class="reference internal" href="#O365.planner.Task" title="O365.planner.Task">Task</a>]</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.planner.Task">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.planner.</span></span><span class="sig-name descname"><span class="pre">Task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Task"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Task" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils/utils.html#O365.utils.utils.ApiComponent" title="O365.utils.utils.ApiComponent"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApiComponent</span></code></a></p>
<p>A Microsoft Planner task</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Task.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Task.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Task.__init__" title="Link to this definition"></a></dt>
<dd><p>A Microsoft planner task</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> (<a class="reference internal" href="#O365.planner.Planner" title="O365.planner.Planner"><em>Planner</em></a><em> or </em><a class="reference internal" href="#O365.planner.Plan" title="O365.planner.Plan"><em>Plan</em></a><em> or </em><a class="reference internal" href="#O365.planner.Bucket" title="O365.planner.Bucket"><em>Bucket</em></a>) – parent object</p></li>
<li><p><strong>con</strong> (<a class="reference internal" href="connection.html#O365.connection.Connection" title="O365.connection.Connection"><em>Connection</em></a>) – connection to use if no parent specified</p></li>
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – protocol to use if no parent specified
(kwargs)</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – use this resource instead of parent resource
(kwargs)</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Task.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Task.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Task.delete" title="Link to this definition"></a></dt>
<dd><p>Deletes this task</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Success / Failure</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Task.get_details">
<span class="sig-name descname"><span class="pre">get_details</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Task.get_details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Task.get_details" title="Link to this definition"></a></dt>
<dd><p>Returns Microsoft 365/AD plan with given id</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#O365.planner.PlanDetails" title="O365.planner.PlanDetails">PlanDetails</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.Task.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#Task.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.Task.update" title="Link to this definition"></a></dt>
<dd><p>Updates this task</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>kwargs</strong> – all the properties to be updated.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Success / Failure</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.active_checklist_item_count">
<span class="sig-name descname"><span class="pre">active_checklist_item_count</span></span><a class="headerlink" href="#O365.planner.Task.active_checklist_item_count" title="Link to this definition"></a></dt>
<dd><p>Number of checklist items with value set to false, representing incomplete items.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.applied_categories">
<span class="sig-name descname"><span class="pre">applied_categories</span></span><a class="headerlink" href="#O365.planner.Task.applied_categories" title="Link to this definition"></a></dt>
<dd><p>The categories to which the task has been applied. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> plannerAppliedCategories</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.assignee_priority">
<span class="sig-name descname"><span class="pre">assignee_priority</span></span><a class="headerlink" href="#O365.planner.Task.assignee_priority" title="Link to this definition"></a></dt>
<dd><p>Hint used to order items of this type in a list view. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.assignments">
<span class="sig-name descname"><span class="pre">assignments</span></span><a class="headerlink" href="#O365.planner.Task.assignments" title="Link to this definition"></a></dt>
<dd><p>The set of assignees the task is assigned to. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> plannerAssignments</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.bucket_id">
<span class="sig-name descname"><span class="pre">bucket_id</span></span><a class="headerlink" href="#O365.planner.Task.bucket_id" title="Link to this definition"></a></dt>
<dd><p>Bucket ID to which the task belongs. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.checklist_item_count">
<span class="sig-name descname"><span class="pre">checklist_item_count</span></span><a class="headerlink" href="#O365.planner.Task.checklist_item_count" title="Link to this definition"></a></dt>
<dd><p>Number of checklist items that are present on the task. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.completed_date">
<span class="sig-name descname"><span class="pre">completed_date</span></span><a class="headerlink" href="#O365.planner.Task.completed_date" title="Link to this definition"></a></dt>
<dd><p>Date and time at which the ‘percentComplete’ of the task is set to ‘100’.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> datetime</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.conversation_thread_id">
<span class="sig-name descname"><span class="pre">conversation_thread_id</span></span><a class="headerlink" href="#O365.planner.Task.conversation_thread_id" title="Link to this definition"></a></dt>
<dd><p>Thread ID of the conversation on the task.  <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.created_date">
<span class="sig-name descname"><span class="pre">created_date</span></span><a class="headerlink" href="#O365.planner.Task.created_date" title="Link to this definition"></a></dt>
<dd><p>Date and time at which the task is created. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> datetime</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.due_date_time">
<span class="sig-name descname"><span class="pre">due_date_time</span></span><a class="headerlink" href="#O365.planner.Task.due_date_time" title="Link to this definition"></a></dt>
<dd><p>Date and time at which the task is due.  <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> datetime</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.has_description">
<span class="sig-name descname"><span class="pre">has_description</span></span><a class="headerlink" href="#O365.planner.Task.has_description" title="Link to this definition"></a></dt>
<dd><p>Value is true if the details object of the task has a
nonempty description and false otherwise. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> bool</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.planner.Task.object_id" title="Link to this definition"></a></dt>
<dd><p>ID of the task. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.order_hint">
<span class="sig-name descname"><span class="pre">order_hint</span></span><a class="headerlink" href="#O365.planner.Task.order_hint" title="Link to this definition"></a></dt>
<dd><p>Hint used to order items of this type in a list view. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.percent_complete">
<span class="sig-name descname"><span class="pre">percent_complete</span></span><a class="headerlink" href="#O365.planner.Task.percent_complete" title="Link to this definition"></a></dt>
<dd><p>Percentage of task completion. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.plan_id">
<span class="sig-name descname"><span class="pre">plan_id</span></span><a class="headerlink" href="#O365.planner.Task.plan_id" title="Link to this definition"></a></dt>
<dd><p>Plan ID to which the task belongs. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.preview_type">
<span class="sig-name descname"><span class="pre">preview_type</span></span><a class="headerlink" href="#O365.planner.Task.preview_type" title="Link to this definition"></a></dt>
<dd><p>his sets the type of preview that shows up on the task.
The possible values are: automatic, noPreview, checklist, description, reference.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.priority">
<span class="sig-name descname"><span class="pre">priority</span></span><a class="headerlink" href="#O365.planner.Task.priority" title="Link to this definition"></a></dt>
<dd><p>Priority of the task. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.reference_count">
<span class="sig-name descname"><span class="pre">reference_count</span></span><a class="headerlink" href="#O365.planner.Task.reference_count" title="Link to this definition"></a></dt>
<dd><p>Number of external references that exist on the task. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> int</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.start_date_time">
<span class="sig-name descname"><span class="pre">start_date_time</span></span><a class="headerlink" href="#O365.planner.Task.start_date_time" title="Link to this definition"></a></dt>
<dd><p>Date and time at which the task starts. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> datetime</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.Task.title">
<span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#O365.planner.Task.title" title="Link to this definition"></a></dt>
<dd><p>Title of the task. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.planner.TaskDetails">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.planner.</span></span><span class="sig-name descname"><span class="pre">TaskDetails</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#TaskDetails"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.TaskDetails" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils/utils.html#O365.utils.utils.ApiComponent" title="O365.utils.utils.ApiComponent"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApiComponent</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.TaskDetails.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#TaskDetails.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.TaskDetails.__init__" title="Link to this definition"></a></dt>
<dd><p>A Microsoft 365 plan details</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> (<a class="reference internal" href="#O365.planner.Task" title="O365.planner.Task"><em>Task</em></a>) – parent object</p></li>
<li><p><strong>con</strong> (<a class="reference internal" href="connection.html#O365.connection.Connection" title="O365.connection.Connection"><em>Connection</em></a>) – connection to use if no parent specified</p></li>
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – protocol to use if no parent specified
(kwargs)</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – use this resource instead of parent resource
(kwargs)</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.planner.TaskDetails.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/planner.html#TaskDetails.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.planner.TaskDetails.update" title="Link to this definition"></a></dt>
<dd><p>Updates this task detail</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>kwargs</strong> – all the properties to be updated.</p></li>
<li><p><strong>checklist</strong> (<em>dict</em>) – the collection of checklist items on the task.</p></li>
</ul>
</dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="n">checklist</span> <span class="o">=</span> <span class="p">{</span>
  <span class="s2">&quot;string GUID&quot;</span><span class="p">:</span> <span class="p">{</span>
    <span class="s2">&quot;isChecked&quot;</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
    <span class="s2">&quot;orderHint&quot;</span><span class="p">:</span> <span class="n">string</span><span class="p">,</span>
    <span class="s2">&quot;title&quot;</span><span class="p">:</span> <span class="n">string</span>
  <span class="p">}</span>
<span class="p">}</span> <span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>description</strong> (<em>str</em>) – description of the task</p></li>
<li><p><strong>preview_type</strong> (<em>str</em>) – <p>this sets the type of preview that shows up on the task.</p>
<p>The possible values are: automatic, noPreview, checklist, description, reference.</p>
</p></li>
<li><p><strong>references</strong> (<em>dict</em>) – the collection of references on the task.</p></li>
</ul>
</dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="n">references</span> <span class="o">=</span> <span class="p">{</span>
  <span class="s2">&quot;URL of the resource&quot;</span> <span class="p">:</span> <span class="p">{</span>
    <span class="s2">&quot;alias&quot;</span><span class="p">:</span> <span class="n">string</span><span class="p">,</span>
    <span class="s2">&quot;previewPriority&quot;</span><span class="p">:</span> <span class="n">string</span><span class="p">,</span> <span class="c1">#same as orderHint</span>
    <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="n">string</span><span class="p">,</span> <span class="c1">#e.g. PowerPoint, Excel, Word, Pdf...</span>
  <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Success / Failure</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.TaskDetails.checklist">
<span class="sig-name descname"><span class="pre">checklist</span></span><a class="headerlink" href="#O365.planner.TaskDetails.checklist" title="Link to this definition"></a></dt>
<dd><p>The collection of checklist items on the task. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> any</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.TaskDetails.description">
<span class="sig-name descname"><span class="pre">description</span></span><a class="headerlink" href="#O365.planner.TaskDetails.description" title="Link to this definition"></a></dt>
<dd><p>Description of the task. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.TaskDetails.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.planner.TaskDetails.object_id" title="Link to this definition"></a></dt>
<dd><p>ID of the task details. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.TaskDetails.preview_type">
<span class="sig-name descname"><span class="pre">preview_type</span></span><a class="headerlink" href="#O365.planner.TaskDetails.preview_type" title="Link to this definition"></a></dt>
<dd><p>This sets the type of preview that shows up on the task.
The possible values are: automatic, noPreview, checklist, description, reference.
When set to automatic the displayed preview is chosen by the app viewing the task.
<div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.planner.TaskDetails.references">
<span class="sig-name descname"><span class="pre">references</span></span><a class="headerlink" href="#O365.planner.TaskDetails.references" title="Link to this definition"></a></dt>
<dd><p>The collection of references on the task. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> any</p>
</dd></dl>

</dd></dl>

</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="onedrive.html" class="btn btn-neutral float-left" title="One Drive" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="sharepoint.html" class="btn btn-neutral float-right" title="Sharepoint" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2025, alejcas.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>